Portal Android SDK/io.portalhq.android.yield

Package-level declarations

Types

Yield

class Yield(api: Api, portal: YieldXyzPortalDependency? = null)

The main entry point for yield-related functionality in the Portal SDK.

YieldActionTarget

sealed class YieldActionTarget

Identifies the yield to act on for a high-level deposit/withdraw.

YieldDepositParams

data class YieldDepositParams(val target: YieldActionTarget, val amount: String, val arguments: YieldXyzEnterArguments? = null)

Parameters for a high-level deposit / withdraw.

YieldDepositResult

data class YieldDepositResult(val hashes: List<String>, val yieldId: String, val status: YieldSubmitResultStatus, val chain: String? = null, val token: String? = null, val yieldOpportunityDetails: YieldOpportunityDetails)

Result of a high-level deposit / withdraw.

YieldOpportunityDetails

data class YieldOpportunityDetails(val yieldId: String, val intent: YieldXyzActionIntent? = null, val type: YieldXyzActionType? = null, val executionPattern: YieldXyzActionExecutionPattern? = null, val status: YieldXyzActionStatus? = null, val amount: String? = null, val amountUsd: String? = null)

A summary of the executed yield action. This is action-level metadata, NOT the full opportunity. Use discover for full opportunity details.

YieldSubmitOptions

data class YieldSubmitOptions(val onProgress: (YieldSubmitProgress) -> Unit? = null, val pollIntervalMs: Long, val timeoutMs: Long)

Options for high-level deposit / withdraw.

YieldSubmitProgress

data class YieldSubmitProgress(val step: YieldSubmitStep, val index: Int, val total: Int, val hash: String? = null)

A single progress event for a deposit/withdraw transaction.

YieldSubmitResultStatus

enum YieldSubmitResultStatus : Enum<YieldSubmitResultStatus>

Final status of a high-level deposit/withdraw.

YieldSubmitStep

enum YieldSubmitStep : Enum<YieldSubmitStep>

Per-transaction progress step emitted by YieldSubmitOptions.onProgress.

YieldWithdrawParams

typealias YieldWithdrawParams = YieldDepositParams

YieldWithdrawResult

typealias YieldWithdrawResult = YieldDepositResult

YieldXyz

class YieldXyz(api: YieldXyzApi, portal: YieldXyzPortalDependency? = null)

YieldXyz provider implementation for discovering and managing yield opportunities.

YieldXyzActionException

sealed class YieldXyzActionException : Exception

Errors thrown by the high-level YieldXyz deposit/withdraw flow.

YieldXyzPortalDependency

interface YieldXyzPortalDependency

Lightweight interface for the Portal capabilities required by the high-level YieldXyz deposit/withdraw flow. The main Portal class implements this interface; tests can use a small mock. Mirrors the EvmAccountTypePortalDependency pattern.